In Group Condition

image23.gif

The In Group Condition is used to test a particle that is sent to it to check to see if it is part of a selected particle Group or sub-group. When the particle is part of the Group, this condition will return a true output.

Operator Inputs 

ON - (Bool) This input data stream determines whether the operator is considered 'on' or 'off'. You can connect other operators to this input channel such as a Bool Helper to activate/deactivate the whole operator.

Time
- (Time) This input data stream is used to define the local time for the operator when the user wants to override the default system time.

Particle
- (Particle) This input data stream reads in the currently selected particle group. The data stream MUST be connected and will be highlighted yellow if it is not.

Group
- (Group) This input data stream is used to pipe in a particle Group to check the particle against.

SubTree
- (Bool) This input data stream is used to override the SubTree checkbox state in the In Group rollout.

Invert
- (Bool) This input data stream is used to override the Invert checkbox state in the In Group rollout.

Operator Outputs 

Out - (Bool) This output data stream sends a true message if the sent particle is part of the selected particle Group.

Rollout Menu
 

image24.gif

In Group
- This dropdown menu lets you choose the particle Group that is to be used as the test group for the particle that comes into the Condition.


SubTree
- As you get into complex Group setups with multiple levels of Groups, you may want to check if the selected particle is part of the group chosen or any of its sub-groups. By activating this checkbox, the In Group Condition will check not only the selected Group, but also any sub-Groups that reside beneath it. When off, only the selected particle Group is tested against.


Invert
- This checkbox acts as a negation for the In Group test. If the selected particle is part of a selected Group, then the In Group condition will send out a False condition when this checkbox is active.